home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / rafbst31.zip / RAFBSTAT.DOC < prev    next >
Text File  |  1991-11-29  |  14KB  |  382 lines
  1.  
  2. ------------------------------------------------------------------------------
  3.                               RaFbStat v3.1
  4.  
  5.           RemoteAccess File Areas Statistics Bulletin Generator
  6.  
  7.                  Copyright (C) 1990-91  Foxtrot Software
  8.                            All Rights Reserved.
  9.  
  10.   This is a shareware program, this program is not to be sold or modified
  11. in any way.  You are free to copy and distribute RaFbStat as long as:
  12.  
  13.   a.  No fee is charged for use of the program or the documentation.
  14.       A fee may be charged for copying or distibution of this software
  15.       and documentation for others not to exceed US$ 10.00.
  16.  
  17.   b.  It is not modified in any way.
  18.  
  19.   c.  You distribute this software along with all documentation and
  20.       registration forms unmodified.
  21.  
  22.  
  23.   The Author hereby disclaims all warranties relating to this software,
  24. whether expressed or implied, including without limitation any implied
  25. warranties of merchantability or fitness for a particular purpose.  The
  26. author will not be liable for any special, incidental, consequenctial,
  27. indirect or simular damages due to loss of data or any other reason.  The
  28. user of this software bears all risk as to the quality  and performance
  29. of this software.
  30.  
  31. -------------------Now that we have that out of the way-----------------------
  32.  
  33.   If you have any comments or suggestions for improvement of this software,
  34. you can contact me at Info-Center BBS, data: (914 )567-1814, 24 hours a
  35. day or leave Net-Mail @FIDO NET 1:272/26, @MagNet 100:900/39.
  36.  
  37.   If you like this software, and decide to keep it on your system and
  38. to use it, then you must register it.  You are entitled to use RAFBStat
  39. for a trial period of 30 days.   RAFBSTat Registration fee is US$8.00. 
  40. New York residents please add 6.5% sales tax to the registration fee.
  41.  
  42.   When registered, you will receive an RAFBStat key for your system.
  43. The KEY you receive will enable the -F option to allow multiple
  44. bulletins to be created.
  45.  
  46.                        Thank you for your support!
  47.  
  48. ------------------------------------------------------------------------------
  49.  
  50. 1. Introduction.
  51.  
  52.    RAFBStat is a utility that will allow the Sysop of a RemoteAccess BBS
  53.    to produce a Files Area Statistic Report that features the following:
  54.  
  55.    a.  Total files in all selected areas.
  56.    b.  Total bytes in all selected areas.
  57.    c.  Total files for each area selected.
  58.    d.  Total bytes for each area selected.
  59.    e.  Percentage of the total files that each area contains.
  60.    f.  Ascii and Ansi Bulletins.
  61.    g.  Multiple bulletins.
  62.    h.  Full File Area Security Level/Security Flag Checking.
  63.  
  64.  
  65.    RAFBStat uses the environment variable RA to find the system files
  66. for your RA BBS system.  If you don't have this variable set then RAFBStat
  67. will try to find the FILES.RA, CONFIG.RA files in the current directory.
  68.  
  69.    Selected areas are determined by using Security and Flags settings
  70. configured in the RAFBSTAT.CTL file.  The Security and Flags used are the
  71. same as that are used in FILES.RA.  Areas that don't match the criteria
  72. specified will not be processed.
  73.  
  74.    RAFBStat allows you to create multiple bulletins by specifying the
  75. -F option at startup.  You can have a different RAFBSTAT.CTL file
  76. that may contain different file area specifications.
  77.  
  78.  
  79. 2.  Files needed by RaFbStat:
  80.  
  81.        INPUT:
  82.  
  83.          CONFIG.RA   -   RA BBS Configuration File.
  84.          FILES.RA    -   File Areas Configuration.
  85.          RAFBSTAT.CTL -  Control file for RAFBSTAT.  Or any .CTL file
  86.                          that is defined on the command line when executed.
  87.  
  88.        OUTPUT:
  89.  
  90.          BULLETIN.ANS
  91.          BULLETIN.ASC -  A bulletin file that you will specify in
  92.                          RAFBSTAT.CTL file.  Actually two files will
  93.                          be created as output.  One is a plain ascii
  94.                          file, the other will contain ansi screen
  95.                          commands for color.  When specifying the
  96.                          filenames, DO NOT append .ASC or .ANS.
  97.                          RAFBSTAT will append an extension for you.
  98.  
  99.         
  100.  
  101.     3.  An Editor that will create text files, such as EDLIN, GALAXY,
  102.         or any Editor that will allow CR/LF combinations at the end of each
  103.         line has to be used.  Create the RAFBStat.Ctl file in your RA BBS
  104.         System directory with the following information:
  105.  
  106.  
  107.  
  108.         b.  The RAFBSTAT.CTL File:
  109.  
  110.         The RAFBStat.CTL file uses KEYWORDS to control how your File
  111.         Areas Statistics are to be created.  The KEYWORDS require also
  112.         one or more arguments to be used with it.  The KEYWORDS may
  113.         appear in upper or lower case or mixed.
  114.  
  115.         1)  PATH    -  This KEYWORD is used to define the path and
  116.                        bulletin name you want to create.
  117.  
  118.              Example:
  119.                 PATH C:\RA\TXTFILES\FILESTAT
  120.  
  121.         2)  TITLE   -  This Keyword is used to define the title you
  122.                        wish to have in the bulletin.  Maximum length
  123.                        for the title is 70 characters.
  124.  
  125.              Example:
  126.                 TITLE Anyname BBS - Anytown, USA
  127.  
  128.         3)   COLOR0  - The color you want the top and bottom lines of the
  129.                        bulletin to be.
  130.  
  131.         4)   COLOR1  - The color you want the title to be.
  132.  
  133.         5)   COLOR2  - The color you want the Last update statement to be.
  134.  
  135.         6)   COLOR3  - The color you want the last update DATE to be.
  136.  
  137.         7)   COLOR4  - The color you want the file areas summary 
  138.                        statement to be.
  139.  
  140.         8)   COLOR5  - The color you want the file areas summary
  141.                        DATA to be.
  142.  
  143.         9)   COLOR6 -  The color you want the File Areas, Files, Bytes,
  144.                        Percent heading to be.
  145.  
  146.         10)  COLOR7 -  The color you want the Area Names to be.
  147.  
  148.         11)  COLOR8 -  The color you want the File Area total files
  149.                        column to be.
  150.  
  151.         12)  COLOR9 -  The color you want the total bytes column of each
  152.                        File Area to be.
  153.  
  154.         13)  COLOR10 - The color you want the File Areas Percent column
  155.                        to be.
  156.  
  157.         14)  BACKGROUND - The color you want the background of the
  158.                           bulletin to be.
  159.  
  160.              Example:
  161.  
  162.                Color0  15
  163.                Color1  14
  164.                Color2  14
  165.                Color3  2
  166.                Color4  15
  167.                Color5  2
  168.                Color6  10
  169.                Color7  14
  170.                Color8  10
  171.                Color9  5
  172.                Color10 13
  173.                Background 0
  174.  
  175.         
  176.         15)  DOWNLOADSEC  - Use this KEYWORD if you want the DOWNLOAD
  177.                             SECURITY level to be checked for each file
  178.                             area.  If this KEYWORD is ommitted, then
  179.                             the download security level will not be
  180.                             checked.  Maximum download security level
  181.                             is 64000.
  182.  
  183.              Example:
  184.                 DownloadSec 5
  185.  
  186.         16)  LISTSEC     - Use this KEYWORD if you want the LIST
  187.                             SECURITY level to be checked for each file
  188.                             area.  If this KEYWORD is ommitted, then
  189.                             the list security level will not be checked.
  190.                             Maximum list security level is 64000.
  191.  
  192.              Example:
  193.                 ListSec 5
  194.  
  195.         17)  UPLOADSEC   - Use this KEYWORD if you want the UPLOAD
  196.                             SECURITY level to be checked for each file
  197.                             area.  If this KEYWORD is ommitted, then
  198.                             the upload security level will not be
  199.                             checked.  Maximum upload security level is
  200.                             64000.
  201.  
  202.              Example:
  203.                 UploadSec 5
  204.  
  205.  
  206.         Note:  The follwing flags correspond to the A,B,C,D flag settings
  207.                that you have set in each File Area.
  208.  
  209.         18)  DOWNLOADSECFLAGS  - Use this KEYWORD if you want the DOWNLOAD
  210.                                  SECURITY flags to be checked for each
  211.                                  file area.  If this keyword is ommitted,
  212.                                  the the download security flags will not
  213.                                  be checked.
  214.  
  215.              Example:
  216.                 DownloadSecFlags X------- X------- X------- X-------
  217.  
  218.  
  219.         19)  LISTSECFLAGS     -  Use this KEYWORD if you want the LIST
  220.                                  SECURITY flags to be checked for each
  221.                                  file area.  If this keyword is ommitted,
  222.                                  the the list security flags will not be
  223.                                  checked.
  224.  
  225.              Example:
  226.                 ListSecFlags X------- X------- X------- X-------           
  227.  
  228.         20)  UPLOADSECFLAGS   -  Use this KEYWORD if you want the UPLOAD
  229.                                  SECURITY flags to be checked for each
  230.                                  file area.  If this keyword is ommitted,
  231.                                  the the upload security flags will not be
  232.                                  checked.
  233.  
  234.              Example:
  235.                 UploadSecFlags X------- X------ X------ X------
  236.  
  237.  
  238.         21)  FILESPECS  - Use this KEYWORD to tell RAFBSTAT what files
  239.                           to include in the bulletin.  Up to 30 FileSpec
  240.                           arguments mat be given.
  241.  
  242.              Example:
  243.                 FileSpecs *.ZIP *.ARC NODEDIFF.A??
  244.                 
  245.  
  246.     c.  How to run RaFbStat:
  247.  
  248.         1) Usage:  RAFBStat [-?] [<-F Path>]
  249.  
  250.             -F Path   - Using this argument will allow you to specify
  251.                         a different path for the .CTL file other than
  252.                         the default RAFBSTAT.CTL.  This option is only
  253.                         available to registered copies of RAFBStat.
  254.  
  255.  
  256.             RAFBStat.Exe need not exist in the RA System directory to
  257.             generate the bulletin(s).   The -F option allows you to
  258.             execute RAFBStat from anywhere on your system.  By default
  259.             RAFBStat will search the currently accessed directory for
  260.             the RAFBStat.CTL file.  
  261.  
  262.     -----------------------------*-----------------------------
  263.  
  264. 6.  Problem(s) History:
  265.  
  266.      10/08/90 - First Release.
  267.      v1.0
  268.  
  269.      10/09/90 - Bug.  Run time error 200 occurred at 0000:1D17.  This was
  270.      v1.1             cause by the grand total files being a zero value and
  271.                       being divided into the file count for the area to
  272.                       produce the percentage.  
  273.  
  274.                 Fix.  Put a trap in the code to not divide when Grand Total
  275.                       is zero.
  276.  
  277.      10/13/90 - Bug.  I found that sometimes that the code used to find
  278.      v1.2             the files specified in the RaFbStat.Ctl file also
  279.                       included the directories where the files were in
  280.                       the Grand Total File Count.  Although this would
  281.                       not cause problems for anyone, it does randomly
  282.                       produce incorrect values.
  283.  
  284.                 Fix.  Checked file attribute for a directory entry and
  285.                       bypass tally logic if true.
  286.  
  287.  
  288.      11/28/91 -       No bugs to report, but I did a complete rewrite of
  289.      v3.0             the program from Pascal to Turbo-C.  The rewrite
  290.                       includes support for RA 1.1 and the following
  291.                       features were added:
  292.  
  293.                       Full Ansi color configurable.
  294.                       Full Download, List, Upload Security Levels/Flags
  295.                       supported and configurable.
  296.                       Overall speed was improved quite a bit.
  297.  
  298.      11/29/91 -       Corrected a background color problem.
  299.      v3.1             Changed this documentation file.
  300.               
  301.        ----------------------------*---------------------------
  302.  
  303. Other Quality Software Products from Foxtrot Software are:
  304.  
  305. Magic name    Description
  306.  
  307. RaTop         Top Users bulletin maker for RemoteAccess 1.1.
  308.  
  309. QuikTop       Top Users bulletin maker for QuickBBS 2.75+            
  310.                    
  311. OpusTop       Top Users bulletin maker for OPUS CBCS 1.1x.
  312.  
  313.  
  314. Coming Soon:
  315.  
  316.     Magic name
  317.  
  318.     SuperTop     - Top Users bulletin maker for SuperBBS bulletin boards.
  319.     QFBStat      - File Areas Statistics Generator for QuickBBS 2.75+.
  320.     
  321.     
  322. PROBLEMS:
  323.  
  324.    Please notify me immediately if you have any problems or
  325. suggestions about this program.  Enhancements are being incorporated
  326. all the time and your input is more vital to this process than you
  327. think.  You may write me, send Net-Mail or logon at the following address:
  328.  
  329. For Registration or reports:
  330.  
  331. Foxtrot Software        
  332. c/o Byron Copeland                   Info-Center BBS
  333. 11 Y Street                          (914) 567-1814 @Fidonet 1:272/26
  334. New Windsor, Ny.                     24 hours a day!
  335. 12553
  336.  
  337.  
  338.  
  339.                   Enjoy and thank you for your support!
  340.  
  341.  
  342.                                - End -
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381. 
  382.